section that has the right to call g_object_unref() in order to remove that
reference.) A #GtkObject is created with a reference count of 1 also, but it
isn't owned by anyone; calling g_object_unref() on the newly-created #GtkObject
-is incorrect. Instead, the initial reference count of a #GtkObject is "floating."
+is incorrect. Instead, the initial reference count of a #GtkObject is "floating".
The floating reference can be removed by anyone at any time, by calling
gtk_object_sink(). gtk_object_sink() does nothing if an object is already
sunk (has no floating reference).
<!-- ##### STRUCT GtkObject ##### -->
<para>
-The object itself. You should never use these members directly-
-instead you the accessing macros.
+The object itself. You should never use these members directly -
+ use the accessing macros instead.
</para>
<!-- ##### MACRO GTK_OBJECT_TYPE ##### -->
<para>
-Get the type of an object.
+Gets the type of an object.
</para>
-@object:
-<!-- # Unused Parameters # -->
-@obj: the object whose type we wish to get.
+@object: a #GtkObject.
<!-- ##### MACRO GTK_OBJECT_TYPE_NAME ##### -->
<para>
-
+Gets the name of an objects type.
</para>
-@object:
+@object: a #GtkObject.
<!-- ##### ENUM GtkObjectFlags ##### -->
<!-- ##### MACRO GTK_OBJECT_FLAGS ##### -->
<para>
-Get the #GtkObjectFlags for an object without directly
+Gets the #GtkObjectFlags for an object without directly
accessing its members.
</para>
<!-- ##### MACRO GTK_OBJECT_CONNECTED ##### -->
<para>
-Test whether a GtkObject has had a signal connected to it.
+Tests whether a #GtkObject has had a signal connected to it.
</para>
@obj: the object to examine.
<!-- ##### MACRO GTK_OBJECT_SET_FLAGS ##### -->
<para>
-Turn on certain object flags. (Private)
+Turns on certain object flags. (Private)
</para>
@obj: the object to affect.
<!-- ##### MACRO GTK_OBJECT_UNSET_FLAGS ##### -->
<para>
-Turn off certain object flags. (Private)
+Turns off certain object flags. (Private)
</para>
@obj: the object to affect.
<!-- ##### FUNCTION gtk_object_new ##### -->
<para>
-Construct an object given its arguments, enumerated in the call to the
+Constructs an object given its arguments, enumerated in the call to the
function. Deprecated in favor of g_object_new().
</para>
@type: the type identifying this object. Returned by gtk_type_unique()
-although (for a properly-written object it should be accessible through
-#GTK_TYPE_FOO.)
-@first_property_name:
+(although for a properly-written object it should be accessible through
+a #GTK_TYPE_FOO macro.)
+@first_property_name: name of the first property to set when constructing
+ the object.
@Varargs: the first argument's value, followed by any number of
-name/argument-value pairs, terminated with NULL.
-@Returns: the new GtkObject.
-<!-- # Unused Parameters # -->
-@first_arg_name: name of the first argument to set when constructing
-the object.
+name/argument-value pairs, terminated with %NULL.
+@Returns: the new #GtkObject.
<!-- ##### FUNCTION gtk_object_sink ##### -->
<!-- ##### FUNCTION gtk_object_ref ##### -->
<para>
-Increase the reference count of the object, simply calls
-g_object_ref() internally.
+Increases the reference count of the object.
Deprecated in favor of g_object_ref().
</para>
@object: the object to reference.
-@Returns: the object which was referenced
+@Returns: @object.
<!-- ##### FUNCTION gtk_object_unref ##### -->
<para>
-Decrease the reference count of an object. When its reference count drops to 0,
-the object is finalized (i.e. its memory is freed). Deprecated in favor of
-g_object_unref(). Simply calls g_object_unref() internally.
+Decreases the reference count of an object. When its reference count drops
+to 0, the object is finalized (i.e. its memory is freed). Deprecated in
+favor of g_object_unref().
</para>
@object: the object to dereference.
<!-- ##### FUNCTION gtk_object_get ##### -->
<para>
-Get properties of an object. Deprecated in favor of g_object_get(). It takes an
-object, then a list of name/return location pairs in a list, followed by NULL.
+Gets properties of an object. Deprecated in favor of g_object_get().
</para>
-@object: a #GtkObject
-@first_property_name: name of first property to get the value for
-@Varargs: list of name-return location pairs.
+@object: a #GtkObject.
+@first_property_name: name of first property to get the value for.
+@Varargs: %NULL-terminated list of name-return location pairs.
<!-- ##### FUNCTION gtk_object_set ##### -->
<para>
-Set properties on an object. Deprecated in favor of g_object_set().
-</para>
-<para>
-It takes an object, then a list of name/value pairs
-in a list, followed by NULL.
+Sets properties on an object. Deprecated in favor of g_object_set().
</para>
<para>
<informalexample>
</informalexample>
</para>
-@object: the object whose arguments should be set.
+@object: a #GtkObject.
@first_property_name: name of the first property to set
@Varargs: the value of the first argument, followed optionally
-by more name/value pairs, followed by NULL.
+by more name/value pairs, followed by %NULL.
<!-- ##### FUNCTION gtk_object_set_data ##### -->
<para>
Deprecated in favor of setting object data to %NULL using g_object_set_data().
Removes a specified datum from the object's data associations (the object_data).
-Subsequent calls to gtk_object_get_data() will return NULL.
+Subsequent calls to gtk_object_get_data() will return %NULL.
</para>
<para>
If you specified a destroy handler with gtk_object_set_data_full(),
@object: the object maintaining the associations.
@key: name of the key for that association.
-@Returns: the data if found, or NULL if no such data exists.
+@Returns: the data if found, or %NULL if no such data exists.
<!-- ##### FUNCTION gtk_object_remove_no_notify ##### -->
<para>
Deprecated in favor of g_object_set_data().
For convenience, every object offers a generic user data
-pointer. The function set it.
+pointer. This function sets it.
</para>
<para>
This function is equivalent to:
@object: object containing the associations.
@data_id: quark of the key.
-@Returns: the data if found, or NULL if no such data exists.
+@Returns: the data if found, or %NULL if no such data exists.
<!-- ##### FUNCTION gtk_object_remove_data_by_id ##### -->
</para>
<para>
Remove a specified datum from the object's data associations.
-Subsequent calls to gtk_object_get_data() will return NULL.
+Subsequent calls to gtk_object_get_data() will return %NULL.
</para>
<para>
Use gtk_object_data_try_key() and gtk_object_data_force_id()
</para>
@object: object containing the associations.
-@key_id:
+@key_id: quark of the key.
<!-- # Unused Parameters # -->
-@data_id: quark of the key.
+@data_id:
<!-- ##### MACRO gtk_object_data_try_key ##### -->
<para>
@GtkType is unique integer identifying the type. The guts of the
information about the type is held in a private struct named
-GtkTypeNode.
+#GtkTypeNode.
</para>
<!-- ##### ENUM GtkFundamentalType ##### -->
<para>
-@GtkFundamentalType is an enumerated type which lists all the possible
-fundamental types (e.g. char, uchar, int, long, float, etc).
+#GtkFundamentalType is an enumerated type which lists all the possible
+fundamental types (e.g. <type>char</type>, <type>uchar</type>, <type>int</type>,
+<type>long</type>, <type>float</type>, etc).
</para>
@GTK_TYPE_INVALID:
<!-- ##### MACRO GTK_CLASS_NAME ##### -->
<para>
-
+Returns the type name of @class.
</para>
-@class:
+@class: a #GtkTypeClass.
<!-- ##### MACRO GTK_CLASS_TYPE ##### -->
<para>
-
+Returns the type of @class.
</para>
-@class:
+@class: a #GtkTypeClass.
<!-- ##### MACRO GTK_TYPE_IS_OBJECT ##### -->
<para>
-
+Returns %TRUE if @type is a %GTK_TYPE_OBJECT.
</para>
-@type:
+@type: a #GtkType.
<!-- ##### MACRO GTK_TYPE_FUNDAMENTAL_LAST ##### -->
<!-- ##### MACRO GTK_TYPE_FUNDAMENTAL_MAX ##### -->
<para>
-The highest maximum fundamental enumerated type value.
+The maximum fundamental enumerated type value.
</para>
<!-- ##### MACRO GTK_STRUCT_OFFSET ##### -->
<para>
-Use in place of offsetof(), which is used if it exists.
+Use in place of <function>offsetof()</function>, which is used if it exists.
</para>
<!-- # Unused Parameters # -->
<!-- ##### MACRO GTK_CHECK_CAST ##### -->
<para>
-Cast the object in @tobj into @cast. If GTK_NO_CHECK_CASTS is
+Casts the object in @tobj into @cast. If GTK_NO_CHECK_CASTS is
defined, just cast it. Otherwise, check to see if we can cast @tobj
into a @cast.
</para>
<!-- ##### MACRO GTK_CHECK_CLASS_CAST ##### -->
<para>
-Cast the object in @tobj into @cast. If GTK_NO_CHECK_CASTS is
+Casts the object in @tobj into @cast. If GTK_NO_CHECK_CASTS is
defined, just cast it. Otherwise, check to see if we can cast @tobj
into a @cast.
</para>
<!-- ##### MACRO GTK_FUNDAMENTAL_TYPE ##### -->
<para>
-Convert a gtk type into a fundamental type
+Converts a Gtk type into a fundamental type.
</para>
<!-- # Unused Parameters # -->
<!-- ##### MACRO GTK_SIGNAL_FUNC ##### -->
<para>
-Just a macroized cast into a GtkSignalFunc
+Just a macroized cast into a #GtkSignalFunc.
</para>
@f:
<!-- ##### TYPEDEF GtkClassInitFunc ##### -->
<para>
-Define a function pointer.
+Defines a function pointer.
</para>
<!-- ##### TYPEDEF GtkObjectInitFunc ##### -->
<para>
-Define a function pointer.
+Defines a function pointer.
</para>
<!-- ##### USER_FUNCTION GtkSignalFunc ##### -->
<para>
-Define a function pointer.
+Defines a function pointer.
</para>
<!-- ##### USER_FUNCTION GtkFunction ##### -->
<para>
-Define a function pointer.
+Defines a function pointer.
</para>
@data: gpointer
<!-- ##### USER_FUNCTION GtkDestroyNotify ##### -->
<para>
-Define a function pointer.
+Defines a function pointer.
</para>
@data: gpointer
<!-- ##### USER_FUNCTION GtkCallbackMarshal ##### -->
<para>
-Define a function pointer.
+Defines a function pointer.
</para>
@object: GtkObject*
<!-- ##### TYPEDEF GtkSignalMarshaller ##### -->
<para>
-Define a function pointer.
+Defines a function pointer.
</para>
<!-- ##### TYPEDEF GtkTypeObject ##### -->
<para>
-A GtkTypeObject defines the minimum structure requirements
+A #GtkTypeObject defines the minimum structure requirements
for type instances. Type instances returned from gtk_type_new ()
-and initialized through a GtkObjectInitFunc need to directly inherit
+and initialized through a #GtkObjectInitFunc need to directly inherit
from this structure or at least copy its fields one by one.
</para>
<!-- ##### MACRO GTK_VALUE_CHAR ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CHAR
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_CHAR.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_UCHAR ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_UCHAR
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_UCHAR.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_BOOL ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_BOOL
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_BOOL.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_INT ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_INT
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_INT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_UINT ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_UINT
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_UINT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_LONG ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_LONG
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_LONG.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_ULONG ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ULONG
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_ULONG.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_FLOAT ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_FLOAT
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_FLOAT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_DOUBLE ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_DOUBLE
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_DOUBLE.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_STRING ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_STRING
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_STRING.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_ENUM ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ENUM
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_ENUM.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_FLAGS ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_FLAGS
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_FLAGS.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_BOXED ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_BOXED
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_BOXED.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_POINTER ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_POINTER
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_POINTER.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_OBJECT ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_OBJECT
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_OBJECT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_SIGNAL ##### -->
<para>
-Use to get the value of a GtkArg whose GtkType is GTK_TYPE_SIGNAL
+Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_SIGNAL.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_CHAR ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_CHAR
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_CHAR.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_UCHAR ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_UCHAR
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_UCHAR.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_BOOL ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_BOOL
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_BOOL.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_INT ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_INT
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_INT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_UINT ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_UINT
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_UINT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_LONG ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_LONG
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_LONG.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_ULONG ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_ULONG
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_ULONG.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_FLOAT ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_FLOAT
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_FLOAT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_DOUBLE ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_DOUBLE
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_DOUBLE.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_STRING ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_STRING
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_STRING.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_ENUM ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_ENUM
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_ENUM.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_FLAGS ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_FLAGS
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_FLAGS.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_BOXED ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_BOXED
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_BOXED.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_POINTER ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_POINTER
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_POINTER.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_OBJECT ##### -->
<para>
-If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_OBJECT
+If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_OBJECT.
</para>
-@a:
+@a: a #GtkArg.
<!-- ##### STRUCT GtkTypeInfo ##### -->
<para>
-Holds information about the type. @gtk_type_name returns the name.
+Holds information about the type. gtk_type_name() returns the name.
@object_size is somehow set to the number of bytes that an instance of
the object will occupy. @class_init_func holds the type's
initialization function. @object_init_func holds the initialization
function for an instance of the object. @reserved_1 is used for
-GtkEnumValue to hold the enumerated values.
+#GtkEnumValue to hold the enumerated values.
</para>
@type_name:
<!-- ##### TYPEDEF GtkTypeClass ##### -->
<para>
-The base structure for a Gtk Type. Every type inherits this as a base structure.
+The base structure for a Gtk type. Every type inherits this as a base structure.
</para>
<!-- ##### FUNCTION gtk_type_init ##### -->
<para>
-Initialize the data structures associated with gtk types.
+Initializes the data structures associated with Gtk types.
</para>
@debug_flags:
<!-- ##### FUNCTION gtk_type_unique ##### -->
<para>
-Create a new, unique type.
+Creates a new, unique type.
</para>
@parent_type: if zero, a fundamental type is created.
@gtkinfo:
-@Returns: the new GtkType.
+@Returns: the new #GtkType.
<!-- # Unused Parameters # -->
-@type_info: must not be null, and @type_info->type_name must also not be null.
+@type_info: must not be %NULL, and @type_info->type_name must also not be %NULL.
<!-- ##### MACRO gtk_type_name ##### -->
<para>
+Returns a pointer to the name of a type, or %NULL if it has none.
</para>
-@type: a GtkType
-@Returns: a pointer to the name of a type, or NULL if it has none.
+@type: a #GtkType.
+@Returns: a pointer to the name of a type, or %NULL if it has none.
<!-- ##### MACRO gtk_type_from_name ##### -->
<para>
-Get the internal representation of a type given its name.
+Gets the internal representation of a type, given its name.
</para>
-@name: the name of a gtk type
-@Returns: a GtkType
+@name: the name of a Gtk type
+@Returns: a #GtkType.
<!-- ##### MACRO gtk_type_parent ##### -->
<para>
-
+Returns the parent type of a #GtkType.
</para>
-@type: a GtkType
-@Returns: the GtkType of the parent
+@type: a #GtkType.
+@Returns: the #GtkType of the parent.
<!-- ##### FUNCTION gtk_type_class ##### -->
<para>
-Return a gpointer pointing to the class of @type or NULL if there was
-any trouble identifying @type. Initialize the class if necessary.
+Returns a pointer pointing to the class of @type or %NULL if there was
+any trouble identifying @type. Initializes the class if necessary.
</para>
-@type: a GtkType
-@Returns: gpointer to the klass.
+@type: a #GtkType.
+@Returns: pointer to the class.
<!-- ##### FUNCTION gtk_type_new ##### -->
<para>
-Create a new object of a given type, and return a gpointer to it.
-Returns NULL if you give it an invalid type. It allocates the object
+Creates a new object of a given type, and return a pointer to it.
+Returns %NULL if you give it an invalid type. It allocates the object
out of the type's memory chunk if there is a memory chunk. The object
has all the proper initializers called.
</para>
-@type: GtkType
-@Returns: gpointer to a GtkTypeObject
+@type: a #GtkType.
+@Returns: pointer to a #GtkTypeObject.
<!-- ##### MACRO gtk_type_is_a ##### -->
<para>
-Look in the type hierarchy to see if @type has @is_a_type among its
+Looks in the type hierarchy to see if @type has @is_a_type among its
ancestors. Do so with a simple lookup, not a loop.
</para>
-@type: GtkType
-@is_a_type: GtkType
-@Returns:
+@type: a #GtkType.
+@is_a_type: another #GtkType.
+@Returns: %TRUE if @type is a @is_a_type.
<!-- ##### FUNCTION gtk_type_enum_get_values ##### -->
If @enum_type has values, then return a pointer to all of them.
</para>
-@enum_type: GtkType
-@Returns: GtkEnumValue*
+@enum_type: a #GtkType.
+@Returns: #GtkEnumValue*
<!-- ##### FUNCTION gtk_type_flags_get_values ##### -->
If @flags_type has values, then return a pointer to all of them.
</para>
-@flags_type:
-@Returns: GtkFlagValue*
+@flags_type: a #GtkType.
+@Returns: #GtkFlagValue*
<!-- ##### FUNCTION gtk_type_enum_find_value ##### -->
<para>
-Return a pointer to one of @enum_type's GtkEnumValues's whose name (or nickname) matches @value_name.
+Returns a pointer to one of @enum_type's #GtkEnumValues's whose name (or nickname) matches @value_name.
</para>
-@enum_type: GtkType
-@value_name:
-@Returns: GtkEnumValue*
+@enum_type: a #GtkType.
+@value_name: the name to look for.
+@Returns: #GtkEnumValue*
<!-- ##### FUNCTION gtk_type_flags_find_value ##### -->
<para>
-Return a pointer to one of @flag_type's GtkFlagValue's whose name (or nickname) matches @value_name.
+Returns a pointer to one of @flag_type's #GtkFlagValue's whose name (or nickname) matches @value_name.
</para>
-@flags_type:
-@value_name:
-@Returns: GtkFlagValue*
+@flags_type: a #GtkType.
+@value_name: the name to look for.
+@Returns: #GtkFlagValue*
<!-- # Unused Parameters # -->
@flag_type: GtkType
position);
}
+/**
+ * gtk_toolbar_remove_space:
+ * @toolbar: a #GtkToolbar.
+ * @position: the index of the space to remove.
+ *
+ * Removes a space from the specified position.
+ **/
void
gtk_toolbar_remove_space (GtkToolbar *toolbar,
gint position)
g_warning ("Toolbar position %d doesn't exist", position);
}
+/**
+ * gtk_toolbar_append_widget:
+ * @toolbar: a #GtkToolbar.
+ * @widget: a #GtkWidget to add to the toolbar.
+ * @tooltip_text: the element's tooltip.
+ * @tooltip_private_text: used for context-sensitive help about this toolbar element.
+ *
+ * Adds a widget to the end of the given toolbar.
+ **/
void
gtk_toolbar_append_widget (GtkToolbar *toolbar,
GtkWidget *widget,
toolbar->num_children);
}
+/**
+ * gtk_toolbar_prepend_widget:
+ * @toolbar: a #GtkToolbar.
+ * @widget: a #GtkWidget to add to the toolbar.
+ * @tooltip_text: the element's tooltip.
+ * @tooltip_private_text: used for context-sensitive help about this toolbar element.
+ *
+ * Adds a widget to the beginning of the given toolbar.
+ **/
void
gtk_toolbar_prepend_widget (GtkToolbar *toolbar,
GtkWidget *widget,
0);
}
+/**
+ * gtk_toolbar_insert_widget:
+ * @toolbar: a #GtkToolbar.
+ * @widget: a #GtkWidget to add to the toolbar.
+ * @tooltip_text: the element's tooltip.
+ * @tooltip_private_text: used for context-sensitive help about this toolbar element.
+ * @position: the number of widgets to insert this widget after.
+ *
+ * Inserts a widget in the toolbar at the given position.
+ **/
void
gtk_toolbar_insert_widget (GtkToolbar *toolbar,
GtkWidget *widget,
icon, callback, user_data, 0);
}
+/**
+ * gtk_toolbar_insert_element:
+ * @toolbar: a #GtkToolbar.
+ * @type: a value of type #GtkToolbarChildType that determines what @widget
+ * will be.
+ * @widget: a #GtkWidget, or %NULL.
+ * @text: the element's label.
+ * @tooltip_text: the element's tooltip.
+ * @tooltip_private_text: used for context-sensitive help about this toolbar element.
+ * @icon: a #GtkWidget that provides pictorial representation of the element's function.
+ * @callback: the function to be executed when the button is pressed.
+ * @user_data: any data you wish to pass to the callback.
+ * @position: the number of widgets to insert this element after.
+ *
+ * Inserts a new element in the toolbar at the given position. If
+ * @type == %GTK_TOOLBAR_CHILD_WIDGET, @widget is used as the new element.
+ * If @type == %GTK_TOOLBAR_CHILD_RADIOBUTTON, @widget is used to determine
+ * the radio group for the new element. In all other cases, @widget must
+ * be %NULL.
+ *
+ * Return value: the new toolbar element as a #GtkWidget.
+
GtkWidget *
gtk_toolbar_insert_element (GtkToolbar *toolbar,
GtkToolbarChildType type,
projects / gtk4.git / commitdiff